Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: adds async checks docs #1193

Merged
merged 9 commits into from
Jul 28, 2022
Merged

docs: adds async checks docs #1193

merged 9 commits into from
Jul 28, 2022

Conversation

EverlastingBugstopper
Copy link
Contributor

this PR adds documentation for the new 🅰️🚰✅ (async checks) functionality that is coming with rover v0.8.0

zionts
zionts approved these changes Jul 27, 2022
View reviewed changes
Copy link

@zionts zionts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good to me! Seems like we should have a way to detect in our user analytics when people are using this background flag or not

@Y-Guo
Copy link
Contributor

Y-Guo commented Jul 27, 2022

Looks good to me! Do we want to tell the user what happens if they use --background without the github integration?

@EverlastingBugstopper
Copy link
Contributor Author

Looks good to me! Do we want to tell the user what happens if they use --background without the github integration?

added the following to both the graph and subgraph check sections:

If you don't want to wait for the check to complete, you can run the command with the --background flag and the check will appear in Apollo Studio on the checks tab.

@EverlastingBugstopper EverlastingBugstopper added this to the vNext milestone Jul 27, 2022
@EverlastingBugstopper EverlastingBugstopper added the docs 📝 improvements or additions to docs on the docs site label Jul 27, 2022
@EverlastingBugstopper EverlastingBugstopper self-assigned this Jul 27, 2022
@Y-Guo
Copy link
Contributor

Y-Guo commented Jul 27, 2022

Seems good to me! Seems like we should have a way to detect in our user analytics when people are using this background flag or not

Can we also get this info from tracking how many people are hitting the new endpoints vs legacy endpoints

Base automatically changed from yangzi/asyncChecks to main July 27, 2022 18:07
@Y-Guo Y-Guo modified the milestones: v0.8.0, vNext Jul 27, 2022
StephenBarlow
StephenBarlow approved these changes Jul 27, 2022
View reviewed changes
Copy link
Contributor

@StephenBarlow StephenBarlow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with some suggestions!

@EverlastingBugstopper EverlastingBugstopper merged commit e17009a into main Jul 28, 2022
@EverlastingBugstopper EverlastingBugstopper deleted the avery/async-checks-docs branch July 28, 2022 14:47
@EverlastingBugstopper EverlastingBugstopper mentioned this pull request Jul 28, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StephenBarlow StephenBarlow StephenBarlow approved these changes

@zionts zionts zionts approved these changes

@Y-Guo Y-Guo Y-Guo approved these changes

Assignees

@EverlastingBugstopper EverlastingBugstopper

Labels
docs 📝 improvements or additions to docs on the docs site
Projects
None yet
Milestone
v0.8.1
Development

Successfully merging this pull request may close these issues.
4 participants
@EverlastingBugstopper @Y-Guo @StephenBarlow @zionts